Class RemoteNetworkImpl

All Implemented Interfaces:
IPCObject, Device, RemoteNetwork

public class RemoteNetworkImpl extends DeviceImpl implements RemoteNetwork
Information provided by the PKI file:

    \class RemoteNetwork
    
    \brief RemoteNetwork handles and manipulates Multiuser remote networks.
    
    \example multiUserManager().getRemoteNetworkAt(0)
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • connect

      public boolean connect(String peerAddress, int peerPort, String userName, String password)
      Information provided by the PKI file:
      
          \brief Makes a Multiuser connection to a peer remote network.
          
          \param peerAddress, the peer address of the peer remote network.
          \param peerPort, the peer port number of the peer remote network.
          \param userName, the peer network name of the peer remote network.
          \param password, the peer password of the peer remote network.
          
          \return bool, true if successful, otherwise false.
          
              
      Specified by:
      connect in interface RemoteNetwork
      Parameters:
      peerAddress - Takes in a parameter of peerAddress
      peerPort - Takes in a parameter of peerPort
      userName - Takes in a parameter of userName
      password - Takes in a parameter of password
      Returns:
      boolean Returns a boolean
    • disconnect

      public void disconnect()
      Information provided by the PKI file:
      
          \brief Disconnects the Multiuser connection.
          
              
      Specified by:
      disconnect in interface RemoteNetwork
    • isConnected

      public boolean isConnected()
      Information provided by the PKI file:
      
          \brief Returns true if the remote network is connected, otherwise false.
          
          \return bool, true if the remote network is connected, otherwise false.
          
              
      Specified by:
      isConnected in interface RemoteNetwork
      Returns:
      boolean Returns a boolean
    • setPeerAddress

      public void setPeerAddress(String address)
      Information provided by the PKI file:
      
          \brief Sets the peer address for the outgoing connection.
          
          \param address, the peer address for the outgoing connection.
          
              
      Specified by:
      setPeerAddress in interface RemoteNetwork
      Parameters:
      address - Takes in a parameter of address
    • getPeerAddress

      public String getPeerAddress()
      Information provided by the PKI file:
      
          \brief Returns the peer address for the outgoing connection.
          
          \return QString, the peer address for the outgoing connection.
          
              
      Specified by:
      getPeerAddress in interface RemoteNetwork
      Returns:
      String Returns a String
    • setPortNumber

      public void setPortNumber(int port)
      Information provided by the PKI file:
      
          \brief Sets the peer port number for the outgoing connection.
          
          \param port, the peer port number for the outgoing connection.
          
              
      Specified by:
      setPortNumber in interface RemoteNetwork
      Parameters:
      port - Takes in a parameter of port
    • getPortNumber

      public int getPortNumber()
      Information provided by the PKI file:
      
          \brief Returns the peer port number for the outgoing connection.
          
          \return int, the peer port number for the outgoing connection.
          
              
      Specified by:
      getPortNumber in interface RemoteNetwork
      Returns:
      int Returns a int
    • setConnectAsUserName

      public void setConnectAsUserName(String username)
      Information provided by the PKI file:
      
          \brief Sets the user name entered when making the outgoing connection.
          
          \param username, the username to use.
          
              
      Specified by:
      setConnectAsUserName in interface RemoteNetwork
      Parameters:
      username - Takes in a parameter of username
    • getConnectAsUserName

      public String getConnectAsUserName()
      Information provided by the PKI file:
      
          \brief Returns the peer network name for the outgoing connection.
          
          \return QString, the peer network name for the outgoing connection.
          
              
      Specified by:
      getConnectAsUserName in interface RemoteNetwork
      Returns:
      String Returns a String
    • setPassword

      public void setPassword(String password)
      Information provided by the PKI file:
      
          \brief Sets the peer password for the outgoing connection.
          
          \param password, the peer password for the outgoing connection.
          
              
      Specified by:
      setPassword in interface RemoteNetwork
      Parameters:
      password - Takes in a parameter of password
    • getPassword

      public String getPassword()
      Information provided by the PKI file:
      
          \brief Returns the peer password for the outgoing connection.
          
          \return QString, the peer password for the outgoing connection.
          
              
      Specified by:
      getPassword in interface RemoteNetwork
      Returns:
      String Returns a String
    • setMode

      public void setMode(boolean bOutgoing)
      Information provided by the PKI file:
      
          \brief Sets the Multiuser connection type to outgoing or incoming.
          
          \param bOutgoing, true for outgoing connection, false for incoming connection.
          
              
      Specified by:
      setMode in interface RemoteNetwork
      Parameters:
      bOutgoing - Takes in a parameter of bOutgoing
    • isOutgoing

      public boolean isOutgoing()
      Information provided by the PKI file:
      
          \brief Returns true if the remote network is set to outgoing connection, false if incoming connection.
          
          \return bool, true if the remote network is set to outgoing connection, false if incoming connection.
          
              
      Specified by:
      isOutgoing in interface RemoteNetwork
      Returns:
      boolean Returns a boolean